/*
 * Fichier: LinkProperties.java
 * Crée le: 28 octobre 2008.
 * Modifié: 14 février 2009.
 * Auteurs: Sébastien ESTIENNE.
 * SiteWeb: http://www.prog-info.org/
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.OF
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package javaexos.gui.common;



import java.awt.Color;



/**
 * <p>Classe représentant les propriétés d'un lien hypertexte.</p>
 * @author Sébastien ESTIENNE.
 */
public class LinkProperties
{
   /** Texte réel. */
   private String text;

   /** L'adresse du lien. */
   private String link;

   /** Indique si le lien a déjà été visité. */
   private boolean visited;

   /** Couleur du lien. */
   private Color linkColor;

   /** Indique si le texte du lien est souligné. */
   private boolean linkUnderlined;

   /** Couleur du lien actif. */
   private Color hoverLinkColor;

   /** Indique si le texte du lien actif est souligné. */
   private boolean hoverLinkUnderlined;

   /** Couleur du lien visité. */
   private Color visitedLinkColor;

   /** Indique si le texte du lien visité est souligné. */
   private boolean visitedLinkUnderlined;


   /**
    * <p>Constructeur.</p>
    * @param text Le texte du lien.
    * @param link Le lien.
    */
   public LinkProperties(String text, String link)
   {
      setText(text);
      setLink(link);
      setVisited(false);
      setLinkColor(Color.blue);
      setLinkUnderlined(true);
      setHoverLinkColor(Color.red);
      setHoverLinkUnderlined(true);
      setVisitedLinkColor(new Color(153, 102, 204));
      setVisitedLinkUnderlined(true);
   }


   /**
    * <p>Renvoie le texte du lien.</p>
    * @return Retourne le texte du lien.
    */
   public String getText()
   {
      return this.text;
   }


   /**
    * <p>Modifie la valeur du texte.</p>
    * @param text La nouvelle valeur du texte.
    */
   protected void setText(String text)
   {
      this.text = text;
   }


   /**
    * <p>Renvoie l'adresse du lien.</p>
    * @return Retourne l'adresse du lien.
    */
   public String getLink()
   {
      return this.link;
   }


   /**
    * <p>Modifie la valeur du lien.</p>
    * @param link La nouvelle valeur du lien.
    */
   protected void setLink(String link)
   {
      this.link = link;
   }


   /**
    * <p>Indique si le lien a déjà été visité.</p>
    * @return Indique si le lien a déjà été visité.
    */
   public boolean isVisited()
   {
      return this.visited;
   }


   /**
    * <p>Modifie la valeur indiquant si le lien a déjà été visité.</p> <p>Par défaut cette valeur
    * est à false.</p>
    * @param visited La nouvelle valeur indiquant si le lien a déjà été visité.
    */
   protected void setVisited(boolean visited)
   {
      this.visited = visited;
   }


   /**
    * <p>Renvoie la couleur du lien.</p>
    * @return Retourne la couleur du lien.
    */
   public Color getLinkColor()
   {
      return this.linkColor;
   }


   /**
    * <p>Modifie la couleur du lien.</p> <p>Par défaut la couleur du lien est bleue.</p>
    * @param color La nouvelle couleur du lien.
    */
   public void setLinkColor(Color color)
   {
      this.linkColor = color;
   }


   /**
    * <p>Indique si le texte du lien est souligné.</p>
    * @return Indique si le texte du lien est souligné.
    */
   public boolean isLinkUnderlined()
   {
      return this.linkUnderlined;
   }


   /**
    * <p>Modifie la valeur indiquant si le lien est souligné.</p> <p>Par défaut le lien est
    * souligné.</p>
    * @param underlined La nouvelle valeur de soulignement.
    */
   public void setLinkUnderlined(boolean underlined)
   {
      this.linkUnderlined = underlined;
   }


   /**
    * <p>Renvoie la couleur du lien actif.</p>
    * @return Retourne la couleur du lien actif.
    */
   public Color getHoverLinkColor()
   {
      return this.hoverLinkColor;
   }


   /**
    * <p>Modifie la couleur du lien actif.</p> <p>Par défaut la couleur du lien actif est rouge.</p>
    * @param color La nouvelle couleur du lien actif.
    */
   public void setHoverLinkColor(Color color)
   {
      this.hoverLinkColor = color;
   }


   /**
    * <p>Indique si le texte du lien actif est souligné.</p>
    * @return Indique si le texte du lien actif est souligné.
    */
   public boolean isHoverLinkUnderlined()
   {
      return this.hoverLinkUnderlined;
   }


   /**
    * <p>Modifie la valeur indiquant si le lien actif est souligné.</p> <p>Par défaut le lien actif
    * est souligné.</p>
    * @param underlined La nouvelle valeur de soulignement.
    */
   public void setHoverLinkUnderlined(boolean underlined)
   {
      this.hoverLinkUnderlined = underlined;
   }


   /**
    * <p>Renvoie la couleur du lien visité.</p>
    * @return Retourne la couleur du lien visité.
    */
   public Color getVisitedLinkColor()
   {
      return this.visitedLinkColor;
   }


   /**
    * <p>Modifie la couleur du lien visité.</p> <p>Par défaut la couleur du lien visité est
    * pourpre.</p>
    * @param color La nouvelle couleur du lien visité.
    */
   public void setVisitedLinkColor(Color color)
   {
      this.visitedLinkColor = color;
   }


   /**
    * <p>Indique si le texte du lien visité est souligné.</p>
    * @return Indique si le texte du lien visité est souligné.
    */
   public boolean isVisitedLinkUnderlined()
   {
      return this.visitedLinkUnderlined;
   }


   /**
    * <p>Modifie la valeur indiquant si le lien visité est souligné.</p> <p>Par défaut le lien
    * visité est souligné.</p>
    * @param underlined La nouvelle valeur de soulignement.
    */
   public void setVisitedLinkUnderlined(boolean underlined)
   {
      this.visitedLinkUnderlined = underlined;
   }
}
